# Translation

We'd love your help to translate *QGroundControl*, and our guides for PX4, *QGroundControl* and MAVLink!

Our docs (and *QGroundControl*) use the [Crowdin](https://crowdin.com) online tool for translation. Crowdin automatically imports source topics from Github and presents new and changed strings for translation and/or review (approval).

Crowdin exports the translated documents back out to Github as a "Pull Request" (which the development team periodically review and accept). The exported output contains the source document with any translated and approved text replaced with translated strings (i.e. if a string is not translated/is changed, then it will be displayed in English).

:::tip
You will need a (free) [Crowdin account](https://crowdin.com/join) account to join the translation team!
:::

:::note
The benefit of this system is that the translation closely tracks the source documents.
Readers will not be mislead by old and out of date translations. 
:::


## Getting Started

The steps to join our translation tream are:
1. Join Crowdin: [https://crowdin.com/join](https://crowdin.com/join)
1. Open the translation project you want to join:
   - [QGroundControl](https://crowdin.com/project/qgroundcontrol)
   - [PX4 User Guide](https://crowdin.com/project/px4-user-guide)
   - [QGroundControl Developer Guide](https://crowdin.com/project/qgroundcontrol-developer-guide)
   - [QGroundControl User Guide](https://crowdin.com/project/qgroundcontrol-user-guide)
   - [MAVLink Guide](https://crowdin.com/project/mavlink)
1. Select the language you want to translate
1. Click the **Join** button (next to the text *You must join the translators team to be able to participate in this project*)  :::note
 You will be notified once your application to join is accepted.

:::
1. Start translating!

## Special Notes

### Do not modify prefix text

Vuepress uses `:::` to mark the beginning of notes, tips and warning:
```html
:::tip
The text for the tip.
:::
```
The text for `:::tip` or `:::warning` etc. should not be modified as it defines the colour of the notebox.

## Adding a New Language

If the language you want to translate is not available then you will need to request it by contacting the project owner (there is a contact link on each project's home page).

:::warning
Maintaining a translation is hard!
Before you ask us to create a new language, please find a few other people to help you translate!
:::


## Getting Help

The *Crowdin* interface is self explanatory, but there is plenty of additional information on the [knowledgeable](https://support.crowdin.com/).

You can also ask for help from translators and developers in the Dronecode community using [our support channels](../contribute/support.md).
